Update Bedrock Runtime client to support Material for MkDocs #24
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
arandito
requested review from
SamRemis,
alexgromero and
jonathan343
and removed request for
SamRemis
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR updates the documentation generation framework for
aws-sdk-bedrock-runtimefrom Sphinx to Material for MkDocs. It also updates the docstring format from RST to Google style with Markdown descriptions.Important
The client was generated using the changes introduced in smithy-lang/smithy-python#592
This PR only updates the standalone docs for
aws-sdk-bedrock-runtime. We plan to implement a top-level documentation site that aggregates all client docs under one site soon. That will exist in this repo.Testing
To generate docs locally:
You can also view the live docs here.
Note
The client was generated using the latest bedrock-runtime model in aws/api-models-aws. This introduced new schemas in
schema.py. We may have to include a changelog for this change.By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.